Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Dapr Shared Docs #4121

Merged
merged 75 commits into from
Jun 27, 2024
Merged

Initial Dapr Shared Docs #4121

merged 75 commits into from
Jun 27, 2024

Conversation

salaboy
Copy link
Contributor

@salaboy salaboy commented Apr 29, 2024

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

This is an initial version of the Dapr Shared docs. Now that Dapr Shared is out of Sandbox, a new set of docs are needed for new users to understand how to use it and get started with Dapr Shared. I would appreciate feedback on the location of these docs and what other sections to include.

Issue reference

Copy link
Collaborator

@hhunter-ms hhunter-ms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

initial review - @msfussell please also take a look!

daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/_index.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/_index.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/_index.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
@hhunter-ms
Copy link
Collaborator

@salaboy - @msfussell suggested I update the diagrams and send you the slides in case you wanted to tweak. Here's the pptx link:

Suggested-Dapr-Share-diagrams.pptx

@salaboy
Copy link
Contributor Author

salaboy commented May 7, 2024

@salaboy - @msfussell suggested I update the diagrams and send you the slides in case you wanted to tweak. Here's the pptx link:

Suggested-Dapr-Share-diagrams.pptx

Thanks a lot for doing this @hhunter-ms ! the diagrams look amazing

@salaboy
Copy link
Contributor Author

salaboy commented May 7, 2024

@hhunter-ms there are a few things that I need to manually change.. but the rest looks good.. I will tackle these changes in the next few days.

Copy link

Stale PR, paging all reviewers

Copy link

Stale PR, paging all reviewers

@github-actions github-actions bot added the stale label May 21, 2024
Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@salaboy - Here are my comments. Let's get this in this week.

daprdocs/content/en/operations/dapr-shared/_index.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/_index.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
daprdocs/content/en/operations/dapr-shared/dapr-shared.md Outdated Show resolved Hide resolved
@hhunter-ms hhunter-ms removed the stale label May 21, 2024
Copy link

Stale PR, paging all reviewers

@github-actions github-actions bot added the stale label May 28, 2024
@msfussell msfussell removed the stale label May 28, 2024
@msfussell msfussell modified the milestones: 1.14, 1.13 May 28, 2024
@msfussell
Copy link
Member

@salaboy - Tell me when you have time to review these comments to that we can get the PR merged. Suggest getting changes to the Dapr-Shared repo at the same time

Copy link

github-actions bot commented Jun 3, 2024

Stale PR, paging all reviewers

@github-actions github-actions bot added the stale label Jun 3, 2024
@salaboy
Copy link
Contributor Author

salaboy commented Jun 4, 2024

bump.. working on this now

@github-actions github-actions bot removed the stale label Jun 5, 2024
@salaboy
Copy link
Contributor Author

salaboy commented Jun 6, 2024

Ok, quick update here.
To get this done, I needed to change the hello-kubernetes quickstart applications to support the SDK supported environment variables: dapr/quickstarts#1029 and dapr/quickstarts#1030

Once these changes are done, I am submitting a PR to the dapr-shared repository with a new tutorial expanding on the hello-kubernetes tutorial to use Dapr Shared.

Finally, I will align this PR to link to that tutorial and maybe use the diagrams shown there.

@hhunter-ms hhunter-ms added the waiting-on-code-pr The code PR needs to be merged before the docs are updated label Jun 10, 2024
@salaboy salaboy force-pushed the dapr-shared branch 2 times, most recently from 628aafb to dd5552a Compare June 21, 2024 16:21
salaboy and others added 22 commits June 27, 2024 20:15
…apr-shared.md

Co-authored-by: Hannah Hunter <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Co-authored-by: Hannah Hunter <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Co-authored-by: Hannah Hunter <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Co-authored-by: Hannah Hunter <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Co-authored-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Co-authored-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Co-authored-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Signed-off-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Signed-off-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Signed-off-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Signed-off-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Signed-off-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Signed-off-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Signed-off-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
…apr-shared.md

Signed-off-by: Mark Fussell <[email protected]>
Signed-off-by: salaboy <[email protected]>
* doc: http metrics path normalization

Signed-off-by: nelson.parente <[email protected]>

* doc: code review & path matching rename

Signed-off-by: nelson.parente <[email protected]>

* doc: add configuration examples

Signed-off-by: nelson.parente <[email protected]>

* update: update docs based on last proposal changes

Signed-off-by: nelson.parente <[email protected]>

* feat: more updates based on the ingress/egress merge

Signed-off-by: nelson.parente <[email protected]>

* doc: code review comments

Signed-off-by: nelson.parente <[email protected]>

* doc: code review comments

Signed-off-by: nelson.parente <[email protected]>

* feat: add excludeVerbs

Signed-off-by: nelson.parente <[email protected]>

* feat: new line

Signed-off-by: nelson.parente <[email protected]>

* feat: add review meeting changes

Signed-off-by: nelson.parente <[email protected]>

* feat: apply hunter suggestions

Signed-off-by: nelson.parente <[email protected]>

---------

Signed-off-by: nelson.parente <[email protected]>
Signed-off-by: salaboy <[email protected]>
Signed-off-by: salaboy <[email protected]>
@salaboy
Copy link
Contributor Author

salaboy commented Jun 27, 2024 via email

@hhunter-ms hhunter-ms merged commit 1547cd8 into dapr:v1.13 Jun 27, 2024
7 checks passed
@marcduiker
Copy link
Contributor

@holopin-bot @salaboy Thanks Salaboy!

Copy link

holopin-bot bot commented Aug 15, 2024

Congratulations @salaboy, the maintainer of this repository has issued you a badge! Here it is: https://holopin.io/claim/clzv8o9wf164060clcsdjvmvli

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants